API

Quality management APIs

POST quality/consequence-areas

Creates a new quality consequence area

HTTP method POST
URI https://api.rambase.net/quality/consequence-areas
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 4340, version 4

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<QualityConsequenceArea>
2
     <Name
Name

Required/mandatory field

Title of the quality consequence area

>{String}</Name>
3
</QualityConsequenceArea>
1
{
2
     "qualityConsequenceArea": {
3
          "name
Name

Required/mandatory field

Title of the quality consequence area

": "{String}"
4
     }
5
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<QualityConsequenceArea>
2
     <QualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

>{Integer}</QualityConsequenceAreaId>
3
     <Status
Status

Status: 1 - Registering, 2 - Analyzing, 3 - Pending actions, 8 - Reviewing, 9 - Closed

Possible domain values can be found here

>{Integer}</Status>
4
     <Name
Name

Title of the quality consequence area

>{String}</Name>
5
     <Description
Description

Description

>{String}</Description>
6
     <SortIndex
SortIndex

Sort index to decide order of the quality consequence areas shown to the users

>{Integer}</SortIndex>
7
     <LowerThreshold
LowerThreshold

Threshold for risk scores. Values less than or equal to this threshold will have a low risk. Medium or higher risks have risk scores greater than this threshold value

>{Integer}</LowerThreshold>
8
     <UpperThreshold
UpperThreshold

Threshold for risk scores. Values less than this threshold will have a low or medium risk. High risks will have risk scores greater than or equal to this threshold value

>{Integer}</UpperThreshold>
9
     <UseDefaultRiskMatrix
UseDefaultRiskMatrix

If this value is true, this consequence areas severities, likelihoods and thresholds will be synchronized with the default matrix

>{Boolean}</UseDefaultRiskMatrix>
10
     <AddedAt
AddedAt

Datetime of when this quality consequence area was added

>{Datetime}</AddedAt>
11
     <AddedBy>
12
          <UserId
UserId

User identifier

>{Integer}</UserId>
13
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
14
          <Name
Name

Name of the user

>{String}</Name>
15
          <UserLink
UserLink

User reference

>{String}</UserLink>
16
     </AddedBy>
17
</QualityConsequenceArea>
1
{
2
     "qualityConsequenceArea": {
3
          "qualityConsequenceAreaId
QualityConsequenceAreaId

Quality consequence identifier

": "{Integer}",
4
          "status
Status

Status: 1 - Registering, 2 - Analyzing, 3 - Pending actions, 8 - Reviewing, 9 - Closed

Possible domain values can be found here

": "{Integer}",
5
          "name
Name

Title of the quality consequence area

": "{String}",
6
          "description
Description

Description

": "{String}",
7
          "sortIndex
SortIndex

Sort index to decide order of the quality consequence areas shown to the users

": "{Integer}",
8
          "lowerThreshold
LowerThreshold

Threshold for risk scores. Values less than or equal to this threshold will have a low risk. Medium or higher risks have risk scores greater than this threshold value

": "{Integer}",
9
          "upperThreshold
UpperThreshold

Threshold for risk scores. Values less than this threshold will have a low or medium risk. High risks will have risk scores greater than or equal to this threshold value

": "{Integer}",
10
          "useDefaultRiskMatrix
UseDefaultRiskMatrix

If this value is true, this consequence areas severities, likelihoods and thresholds will be synchronized with the default matrix

": "{Boolean}",
11
          "addedAt
AddedAt

Datetime of when this quality consequence area was added

": "{Datetime}",
12
          "addedBy": {
13
               "userId
UserId

User identifier

": "{Integer}",
14
               "firstName
FirstName

First name of the user

": "{String}",
15
               "name
Name

Name of the user

": "{String}",
16
               "userLink
UserLink

User reference

": "{String}"
17
          }
18
     }
19
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 105657 HTTP 404 Could not find consequence area.
Error 105674 HTTP 404 Could not find translation
Error 105715 HTTP 400 You can not have multiple translations of the same language